<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: api/inc/fpc_bep_image.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__bep__image_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">fpc_bep_image.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Fingerprint image API.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
<code>#include &quot;<a class="el" href="fpc__bep__types_8h_source.html">fpc_bep_types.h</a>&quot;</code><br />
</div>
<p><a href="fpc__bep__image_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfpc__bep__image__dimensions__t.html">fpc_bep_image_dimensions_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image dimensions.  <a href="structfpc__bep__image__dimensions__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:aacb10dffb536ff553815d53558a77bf2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__image_8h.html#aacb10dffb536ff553815d53558a77bf2">fpc_bep_image_new</a> (void)</td></tr>
<tr class="memdesc:aacb10dffb536ff553815d53558a77bf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates resources for a new image.  <a href="#aacb10dffb536ff553815d53558a77bf2">More...</a><br /></td></tr>
<tr class="separator:aacb10dffb536ff553815d53558a77bf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b516d4d673c231f8441f348ef39f3b9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__image_8h.html#a1b516d4d673c231f8441f348ef39f3b9">fpc_bep_image_delete</a> (<a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> **image)</td></tr>
<tr class="memdesc:a1b516d4d673c231f8441f348ef39f3b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases the provided image and the resources associated with it.  <a href="#a1b516d4d673c231f8441f348ef39f3b9">More...</a><br /></td></tr>
<tr class="separator:a1b516d4d673c231f8441f348ef39f3b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac67c0a74b41329c8386b2ee4a7d1f34c"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__image_8h.html#ac67c0a74b41329c8386b2ee4a7d1f34c">fpc_bep_image_get_size</a> (const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *image)</td></tr>
<tr class="memdesc:ac67c0a74b41329c8386b2ee4a7d1f34c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the image pixels in number of bytes.  <a href="#ac67c0a74b41329c8386b2ee4a7d1f34c">More...</a><br /></td></tr>
<tr class="separator:ac67c0a74b41329c8386b2ee4a7d1f34c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33ccf8d2b78ebe7b57a02c4110632984"><td class="memItemLeft" align="right" valign="top">uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__image_8h.html#a33ccf8d2b78ebe7b57a02c4110632984">fpc_bep_image_get_pixels</a> (const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *image)</td></tr>
<tr class="memdesc:a33ccf8d2b78ebe7b57a02c4110632984"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the image pixels.  <a href="#a33ccf8d2b78ebe7b57a02c4110632984">More...</a><br /></td></tr>
<tr class="separator:a33ccf8d2b78ebe7b57a02c4110632984"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf44e4aa57fb7e23addf238098015d6b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__image_8h.html#aaf44e4aa57fb7e23addf238098015d6b">fpc_bep_image_get_dimensions</a> (const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *image, <a class="el" href="structfpc__bep__image__dimensions__t.html">fpc_bep_image_dimensions_t</a> *dimensions)</td></tr>
<tr class="memdesc:aaf44e4aa57fb7e23addf238098015d6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the dimensions of the image.  <a href="#aaf44e4aa57fb7e23addf238098015d6b">More...</a><br /></td></tr>
<tr class="separator:aaf44e4aa57fb7e23addf238098015d6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Fingerprint image API. </p>
<p>This is the fingerprint image API of the Biometric Embedded Platform (BEP) library. The library contains functionality for use with biometric hardware from Fingerprint Cards. It is targeting embedded systems with tight restrictions on available CPU, memory and storage resources.</p>
<p>The library is by definition executing in the same security domain as the caller, therefore the API does not define any security mechanisms and it is the responsibility of the caller to securely deliver and protect any sensitive data being delivered to other parts of the system.</p>
<dl class="section note"><dt>Note</dt><dd>Before using this API the sensor must be initialized, see <a class="el" href="fpc__bep__sensor_8h.html#a7d7ca04903a7b5f993ac7a4019f97b3e" title="Initializes the fingerprint sensor part of FPC BEP library. ">fpc_bep_sensor_init()</a>.</dd>
<dd>
This is a work-in-progress specification. Implementers are informed that this API may change without providing any backward compatibility. However it is FPC's ambition that the API shall remain compatible between releases. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1b516d4d673c231f8441f348ef39f3b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b516d4d673c231f8441f348ef39f3b9">&#9670;&nbsp;</a></span>fpc_bep_image_delete()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void fpc_bep_image_delete </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> **&#160;</td>
          <td class="paramname"><em>image</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Releases the provided image and the resources associated with it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The image to release. If NULL, no operation is performed. Image pointer set to NULL when released. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="aaf44e4aa57fb7e23addf238098015d6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf44e4aa57fb7e23addf238098015d6b">&#9670;&nbsp;</a></span>fpc_bep_image_get_dimensions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> fpc_bep_image_get_dimensions </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *&#160;</td>
          <td class="paramname"><em>image</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structfpc__bep__image__dimensions__t.html">fpc_bep_image_dimensions_t</a> *&#160;</td>
          <td class="paramname"><em>dimensions</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the dimensions of the image. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The image. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">dimensions</td><td>The image dimensions. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4" title="Common results returned by BEP functions. ">fpc_bep_result_t</a> </dd></dl>

</div>
</div>
<a id="a33ccf8d2b78ebe7b57a02c4110632984"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33ccf8d2b78ebe7b57a02c4110632984">&#9670;&nbsp;</a></span>fpc_bep_image_get_pixels()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t* fpc_bep_image_get_pixels </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *&#160;</td>
          <td class="paramname"><em>image</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the image pixels. </p>
<p>Returns a reference to the image pixels. When the image has been deleted using <a class="el" href="fpc__bep__image_8h.html#a1b516d4d673c231f8441f348ef39f3b9" title="Releases the provided image and the resources associated with it. ">fpc_bep_image_delete()</a> the pixels are no longer valid.</p>
<p>The size of the returned pixels can be retrieved using <a class="el" href="fpc__bep__image_8h.html#ac67c0a74b41329c8386b2ee4a7d1f34c" title="Gets the size of the image pixels in number of bytes. ">fpc_bep_image_get_size()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The image. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The image pixels. </dd></dl>

</div>
</div>
<a id="ac67c0a74b41329c8386b2ee4a7d1f34c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac67c0a74b41329c8386b2ee4a7d1f34c">&#9670;&nbsp;</a></span>fpc_bep_image_get_size()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">size_t fpc_bep_image_get_size </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a> *&#160;</td>
          <td class="paramname"><em>image</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the size of the image pixels in number of bytes. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>The image. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Size of image pixels in number of bytes. </dd></dl>

</div>
</div>
<a id="aacb10dffb536ff553815d53558a77bf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacb10dffb536ff553815d53558a77bf2">&#9670;&nbsp;</a></span>fpc_bep_image_new()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a>* fpc_bep_image_new </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Allocates resources for a new image. </p>
<dl class="section return"><dt>Returns</dt><dd>The allocated image, or NULL if no resources are available. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li><li class="navelem"><a class="el" href="dir_d218fd71c02742082feaad64e43c1ecd.html">inc</a></li><li class="navelem"><a class="el" href="fpc__bep__image_8h.html">fpc_bep_image.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
